We strongly recommend that you experiment with the program for a few minutes before reading this manual. Try the following commands: Install IXREF by copying 'ixref.exe' to your favorite utilities directory. "cd" to any directory with 'C/C++' files "ixref *.h *.c *.cpp" Press 'F1' for help Experiment with the different menus and windows. Position the cursor over any text on the screen and press the mouse button. Try the "Tab", "Enter", "Up", "Down", "Page Up", and "Page Down" keys in all of the windows and see what happens. ------------------ Introduction.-------------------------------------- Interactive Cross Reference (IXREF) is a simple programming tool that helps the programmer quickly understand C or C++ source code. This manual includes chapters describing how to use this tool. Features: IXREF lets you cross reference C or C++ source code and your text files. It has: * simple point-and-click action using the mouse or keyboard for selection. * fast database load time. * easy-to-use interface with standard menu and status line layout. If you use Borland IDE, Microsoft PWB, Windows, OS/2, or Apple Macintosh before, you can master this software interface in seconds. * support for multiple windows to multiple project database. Requirements: * IBM PC or clone with at lease 512K of memory. Supports: * EGA/VGA 43/50 lines screens. * Mouse. * It runs under Window, OS/2 as DOS program. ------------------ CHAPTER 1 Getting Started. ---------------------- This chapter gives you information about how to install Interactive Cross Reference Tool and convers the basics for starting the program. ---- Installing Interactive Cross Reference Tool ---- To Install Interactive Cross Reference, just copy the ixref.exe from the program disk to you favor programming utilities directory. ---- Starting Interactive Cross Reference Tool ---- Type "ixref" to start the program. Use one or more of the following options to build or read an existing database. Command Line Options ------------------------------------------------------------- Option Description ------------------------------------------------------------- -x filename.xrf Load "filename.xrf" cross reference database. filename.ext Read "filename.ext" as source file, then build the XRF database for the file. Examples: "IXREF *.H *.CPP" Builds a cross reference database for all of the .h and .cpp files in current directory. Alt-x Exits the program. -------------------- Identifier List Box: -------------------- This list box contains all of the identifiers in the source files. This list appears on the upper left side of the window. Special keys in this window pane: -------------------------------------------------------------- UP, DOWN, PAGE UP, PAGE DOWN: Scroll the identifiers list. ENTER, "Right Mouse Button": Enter current selection in the History List Box. Tab: Move cursor to the Reference List Box. a,z, A, Z: Interactively search for case-sensitive identifier string in the database. ------------------- Reference List Box: ------------------- This list box contains all of the references to the current identifier in the Identifier List Box. This list appears in the upper middle section of the window. Special Keys in this window pane: -------------------------------------------------------------- UP, DOWN, PAGE UP, PAGE DOWN: Scroll the identifiers list. ENTER, "Right Mouse Button": Enter current selection in the History List Box. Tab: Move cursor to the Reference List Box. ----------------- History List Box: ----------------- This list box maintains a list of previously referenced items. The initially empty list is updated automatically when you press "ENTER" while in the various window panes. This list appears in the upper right side of the window. Special Keys in this window pane: -------------------------------------------------------------- UP, DOWN, PAGE UP, PAGE DOWN: Scroll the identifiers list. As this list is scrolled, the other lists are automatically updated. Tab: Move cursor to the File Viewer Window. ------------------- File Viewer Window: ------------------- This window pane lets you view the source file that references the current token. This window pane is located in the lower portion of the window. Special Keys in this window pane: -------------------------------------------------------------- UP, DOWN, PAGE UP, PAGE DOWN: Scroll the currently displayed file. ENTER: Query the database for the referenced token. If a match is found, this identifier is entered into the History List box. Tab: Move cursor to the Reference List Box. Left Mouse: Display reference for the token to which the cursor is pointing. Right Mouse: Same as "Left Mouse"; also add current reference to the History List. ------------------ CHAPTER 2 Working with Borland IDE. ------------- This software is designed to work with Borland IDE. You can output the reference list items into the message window of IDE. Here's how you do it: PART A: Install "ixref" into IDE. 1) From within IDE, select the "Options->Transfer..." menu. 2) Move to the last item in the "Program Titles" pane. 3) Press the "Enter" key. You are now in the "Modify/New Transfer Item" dialog box. 4) Under 'Program Title', enter "I~Xref". 5) Under 'Program Path', enter "ixref". 6) Under 'Command Line', enter "$PROMPT $CAP MSG(GREP2MSG)". 7) Click on the "New" Button. You are now in the "Transfer" dialog box. 8) Click on the "OK" Button. You are now in the main IDE screen. PART B: Interactively use "ixref" with Borland IDE. 9) Press "Alt-Space" or select the system menu icon. 10) Press "x" or select "ixref" item. A dialog prompts you for the "Program Arguments". 11) Enter your program arguments. (e.g. "*.h *.c *.cpp") 12) Click on the "OK" Button. You are transferred to the 'ixref' program. 13) Query the identifiers, etc.... 14) Select "File" - "Exit out ref". You are now back in IDE. The last item you referenced should now be in the message window. You may find the following book helpful in designing and using the Interactive Cross Referencing tool with IDE: Borland IDE user manual APPENDIX A. Quick References. ----------------------------- Keys Context Functions ----------------------------------------------- Tab Move cursor to next window pane or dialog box item Enter File Viewer Query for the word under the cursor Enter Ref ListBox Add current reference to History Box Enter Ident ListBox Add current Identifier to History Box Keys Menu Command Functions ----------------------------------------------- Alt-X File Exit Quit program F1 Help F2 File Save Save cross reference database F3 File Open Open cross reference database F4 File New Open new database F5 Window Zoom Zoom/unzoom current window F6 Next Window Select next window F8 Misc Add Add more source to current database F10 Go to system menu Alt-F3 Close current database window Alt-F Select File menu Alt-W Select Window menu Alt-M Select Misc menu ----------------end-of-author's-documentation--------------- Software Library Information: This disk copy provided as a service of Public (software) Library We are not the authors of this program, nor are we associated with the author in any way other than as a distributor of the program in accordance with the author's terms of distribution. Please direct shareware payments and specific questions about this program to the author of the program, whose name appears elsewhere in this documentation. If you have trouble getting in touch with the author, we will do whatever we can to help you with your questions. All programs have been tested and do run. To report problems, please use the form that is in the file PROBLEM.DOC on many of our disks or in other written for- mat with screen printouts, if possible. PsL cannot debug pro- programs over the telephone, though we can answer questions. Disks in the PsL are updated monthly, so if you did not get this disk directly from the PsL, you should be aware that the files in this set may no longer be the current versions. Also, if you got this disk from another vendor and are having prob- lems, be aware that some files may have become corrupted or lost by that vendor. Get a current, working disk from PsL. For a copy of the latest monthly software library newsletter and a list of the 4,000+ disks in the library, call or write Public (software) Library P.O.Box 35705 Houston, TX 77235-5705 Orders only: 1-800-2424-PSL MC/Visa/AmEx/Discover Outside of U.S. or in Texas or for general information, Call 1-713-524-6394